Class DiscountCreate

Description

This Class represents a dataobject for creating a Discount



        
Variable Summary
Variables
int $AmountSpent

The spent amount of the Discount - must be less than or equal to Value when type is `f`

string $Code

The code of the Discount

string $DateCreated

The the date the Discount was created

string $DateExpire

The expiry date of the Discount (empty for none)

int $Limit

The the useage limit of the Discount

int[] $ProductIds

The ids of the products related to this Discount

DiscountCustomerAssociation $DiscountCustomerAssociation

The customer associations related to this Discount

DiscountCustomerGroupAssociation $DiscountCustomerGroupAssociation

The customer group associations related to this Discount

string $Title

The title of the Discount

string $Type

The type of the Discount ('p' for percentage, 'f' for fixed amount, 'fs' for free shipping, 'fg' for free gift). Free shipping and free gift require a Growth, Advanced, or Success plan.

int $UseCount

The use count of the Discount

double $Value

The value of the Discount (either percentage of fixed amount according to the Type)

int $Vat

Wether or not the Discount has VAT

dateTime $StartDate

The start date of the discount

bool $IsActive

If the Discount is active

bool $IsRestrictedToNewCustomer

If the Discount is restricted to new customers

double $MinimumCartValue

Minimum cart discount to to make discount applicable

DiscountedProductCategories $DiscountedProductCategories

Product Category limitations of this Discount. Optional. Only created if the field is set.

bool $IsSingleUsePerCustomer

If the Discount is restricted to a single use per customer

int[] $DeliveryMethodIds

The delivery method IDs to associate with this free shipping discount (only applicable when Type is 'fs')

DiscountFreeGift $FreeGift

The free gift association for this discount (only applicable when Type is 'fg'). Contains ProductId (required), VariantId (required if product has variants), and Amount (defaults to 1).

Documentation generated on Thu, 26 Jul 2018 13:22:46 +0000 by phpDocumentor 1.4.4